MbimTransport.h

Go to the documentation of this file.

#ifndef __MBIM_TRANSPORT_H__
#define __MBIM_TRANSPORT_H__


#include <stdint.h>
#include <pthread.h>
#include "MbimIndicator.h"
#include "MbimTransaction.h"

#ifdef __cplusplus
extern "C" {
#endif


#define MBIM_UUID_SIZE 16 
#define MBIM_MAX_CIDS 64  
// TODO: determine at runtime by quering USB descriptor or ioctl to driver.
#define MBIM_MAX_CTRL_TRANSFER 4096  
#define MBIM_COMMAND_TYPE_QUERY 0  
#define MBIM_COMMAND_TYPE_SET   1  
#define MBIM_STATUS_SUCCESS   0  
#define MBIM_STATUS_FAILURE   2  
typedef struct MbimTransport
{
    int deviceFd;   // FD of device.
#ifndef EVENT_FD_UNSUPPORTED
    int shutdownFd; // FD of shutdown event.
#else
    int shutdownFd[2]; // FDs of shutdown pipe.
#endif
    pthread_mutex_t writeLock;  // Protect write operations.
    pthread_t readThread;
    uint32_t transactionId;
    pthread_mutex_t transactionIdLock;
    MbimTransaction* transactionList;       // Head of list of outstanding transactions.
    pthread_mutex_t transactionListLock;
    struct MultiFragmentMessage* pIncomingMessage; // Workspace to assemble incoming fragments.
    MbimIndicator* indicatorList;       // Head of list of indicators.
    pthread_mutex_t indicatorListLock;
} MbimTransport;

int MbimTransport_Initialize(MbimTransport* pThis, char *devicePath, uint32_t maxExpectedInformationLength);

void MbimTransport_ShutDown(MbimTransport* pThis);

int MbimTransport_SendCommand(
                            MbimTransport* pThis,
                            const uint8_t* deviceServiceId,
                            uint32_t cid,
                            uint32_t commandType,
                            uint8_t* informationBuffer,
                            uint16_t informationBufferLength,
                            MbimTransaction* pTransaction
                          );

uint32_t MbimTransport_GetNextTransactionId(MbimTransport* pThis);

void MbimTransport_CancelTransaction(MbimTransport* pThis, uint32_t transactionId);

void MbimTransport_AttachIndicator(MbimTransport* pThis, MbimIndicator* pIndicator);

void MbimTransport_DetachIndicator(MbimTransport* pThis, MbimIndicator* pIndicator);

#ifdef __cplusplus
} /* extern "C" { */
#endif

#endif //__MBIM_TRANSPORT_H__